Onboarding: Replace react-confetti with @neoconfetti/react
#30098
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit f202d2a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
yannbf
approved these changes
Dec 18, 2024
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 0 | 0 | 0 |
| Self size | 235 KB | 218 KB | 🎉 -16 KB 🎉 |
| Dependency size | 664 B | 664 B | 0 B |
| Bundle Size Analyzer | Link | Link |
yannbf
changed the title
react-confettireact-confetti with react-confetti-boom
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
9 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
| return container; | ||
| }); | ||
| }: ComponentProps<typeof ReactConfetti> & { timeToFade?: number }) { | ||
| const [particleCount, setParticleCount] = useState(42); |
There was a problem hiding this comment.
style: initial particleCount of 42 seems arbitrary and much lower than original implementation which could affect visual impact
…ing-alternative Addon Onboarding: Use @neoconfetti/react as alternative
yannbf
changed the title
react-confetti with react-confetti-boomreact-confetti with @neoconfetti/react
6 tasks
This was referenced Dec 19, 2024
ndelangen
added
the
needs qa
yannbf
removed
the
needs qa
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #30095
What I did
It looks like the dist code of
react-confetti(maybe just the minified version) contains code, that makes it impossible foresbuildto understand the requires/imports. It might just be too dynamic due to some syntax-compression/optimization.Instead of diving deep into the rabbit hole, we propose replacing the dependency (which is unmaintained) with a newer, well maintained replacement, @neoconfetti/react.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I tested this manually by making a prod build of the addon package, and copying this over to a project I had, that I verfied was showing the problem before.
QA should include going through the onboarding process once, and verifying there is confetti.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Replaces react-confetti with react-confetti-boom to resolve esbuild bundling issues in the onboarding addon, resulting in significant bundle size improvements.
code/addons/onboarding/src/components/Confetti/Confetti.tsxto use react-confetti-boom with simplified implementationcode/e2e-tests/addon-onboarding.spec.tsto verify onboarding flow functionalitycode/addons/onboarding/src/Onboarding.tsxby using default values